SDK reference polish#6741
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This was referenced Jul 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation changes
Copy edits to the SDK reference setup guide
For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience
Note
Low Risk
Documentation-only copy and component changes with no runtime or configuration behavior changes.
Overview
Polishes the SDK reference setup guide in
sdk-reference-setup.mdxso it matches patterns used in sibling API playground docs (e.g. GraphQL setup).Adds a
<Note>on tab-onlysdkusage: allowedgroups, forbidden nav structures (pages,versions,languages), and incompatibility withopenapi,asyncapi, andgraphql.Replaces
ResponseFieldwithParamFieldforformat,source, anddirectory.sourcenow explicitly states HTTPS only (no HTTP). Multi-library guidance now stresses a uniquedirectoryto avoid route collisions.Adds a new Generated pages section describing how Mintlify orders nav groups after tab
groups, how grouping varies by format, per-symbol pages with cross-links, and the fallbackReferencegroup for ungrouped pages.Reviewed by Cursor Bugbot for commit 79e6952. Bugbot is set up for automated code reviews on this repo. Configure here.